Throw useful error on bad docs snippets #25389
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
You can continue a test started in a previous snippet by marking the next snippet with `// TEST[continued]`. The trouble is, if you mark the first snippet in a file with `// TEST[continued]` you'd get difficult to predict behavior because you'd continue the test started in another file. This will usually create a test that fails the build but it isn't easy to track down what you did wrong. This commit catches this scenario up front and fails the build with a useful error message. Similarly, if you put `// TEST[continued]` directly after a `// TESTSETUP` section then the docs tests will fail to run but the error message did not point you to the `// TEST[continued]` snippet. This commit catches this scenario up front as well and fails the build with a useful error message.
|
@lcawl and @tbrooks8, this would have caught the error that we talked about on Friday. And it'd catch an error that I've had a few times that is similarly difficult to track down. And it'd spit out a much more obvious error message. |
|
Thanks for reviewing @cbuescher! |
nik9000
added a commit
that referenced
this pull request
Jun 26, 2017
You can continue a test started in a previous snippet by marking the next snippet with `// TEST[continued]`. The trouble is, if you mark the first snippet in a file with `// TEST[continued]` you'd get difficult to predict behavior because you'd continue the test started in another file. This will usually create a test that fails the build but it isn't easy to track down what you did wrong. This commit catches this scenario up front and fails the build with a useful error message. Similarly, if you put `// TEST[continued]` directly after a `// TESTSETUP` section then the docs tests will fail to run but the error message did not point you to the `// TEST[continued]` snippet. This commit catches this scenario up front as well and fails the build with a useful error message.
jasontedor
added a commit
to jasontedor/elasticsearch
that referenced
this pull request
Jun 26, 2017
* master: Throw useful error on bad docs snippets (elastic#25389) Remove `mapping.single_type` from parent join test (elastic#25391) Tests: Fix array out of bounds exception in TemplateUpgradeServiceIT
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can continue a test started in a previous snippet by marking the
next snippet with
// TEST[continued]. The trouble is, if you mark thefirst snippet in a file with
// TEST[continued]you'd get difficultto predict behavior because you'd continue the test started in another
file. This will usually create a test that fails the build but it isn't
easy to track down what you did wrong. This commit catches this
scenario up front and fails the build with a useful error message.
Similarly, if you put
// TEST[continued]directly after a// TESTSETUPsection then the docs tests will fail to run but theerror message did not point you to the
// TEST[continued]snippet.This commit catches this scenario up front as well and fails the build
with a useful error message.